<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Checks in an object</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="ref.hwapi.html">Hyperwave API 函数</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="hwapi.checkout.html">hw_api::checkout</a></div>
 <div class="up"><a href="ref.hwapi.html">Hyperwave API 函数</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="hwapi.checkin" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hw_api::checkin</h1>
  <p class="verinfo">(PHP 4, PHP 5 &lt; 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::checkin</span> &mdash; <span class="dc-title">Checks in an object</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-hwapi.checkin-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">bool</span> <span class="methodname"><strong>hw_api::checkin</strong></span>
    ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span>
   )</div>

  <p class="para rdfs-comment">
   This function checks in an object or a whole hierarchy of objects.
   The parameters array contains the required element
   &#039;objectIdentifier&#039; and the optional element &#039;version&#039;, &#039;comment&#039;, &#039;mode&#039;
   and
   &#039;objectQuery&#039;. &#039;version&#039; sets the version of the object. It consists of
   the major and minor version separated by a period. If the version is not
   set, the minor version is incremented. &#039;mode&#039; can be one of the following
   values:
   <dl>

    
     <dt>
HW_API_CHECKIN_NORMAL</dt>

     <dd>

      <span class="simpara">
       Checks in and commits the object. The object must be a document.
      </span>
     </dd>

    
    
     <dt>
HW_API_CHECKIN_RECURSIVE</dt>

     <dd>

      <span class="simpara">
       If the object to check in is a collection, all children will be
       checked in recursively if they are documents. Trying to check in
       a collection would result in an error.
      </span>
     </dd>

    
    
     <dt>
HW_API_CHECKIN_FORCE_VERSION_CONTROL</dt>

     <dd>

      <span class="simpara">
       Checks in an object even if it is not under version control.
      </span>
     </dd>

    
    
     <dt>
HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</dt>

     <dd>

      <span class="simpara">
       Check if the new version is different from the last version. Unless
       this is the case the object will be checked in.
      </span>
     </dd>

    
    
     <dt>
HW_API_CHECKIN_KEEP_TIME_MODIFIED</dt>

     <dd>

      <span class="simpara">
       Keeps the time modified from the most recent object.
      </span>
     </dd>

    
    
     <dt>
HW_API_CHECKIN_NO_AUTO_COMMIT</dt>

     <dd>

      <span class="simpara">
       The object is not automatically committed on check-in.
      </span>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-hwapi.checkin-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<em><code class="parameter">parameter</code></em></dt>

     <dd>

      <p class="para">
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-hwapi.checkin-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-hwapi.checkin-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><a href="hwapi.checkout.html" class="xref">hw_api::checkout</a></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="ref.hwapi.html">Hyperwave API 函数</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="hwapi.checkout.html">hw_api::checkout</a></div>
 <div class="up"><a href="ref.hwapi.html">Hyperwave API 函数</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
